// 版权归Go作者所有。版权所有。
// 此源代码的使用受BSD样式的约束
// 可以在许可证文件中找到的许可证。

package ld

import (
	"cmd/internal/goobj"
	"cmd/internal/objabi"
	"cmd/internal/sys"
	"cmd/link/internal/loader"
	"cmd/link/internal/sym"
	"fmt"
	"internal/buildcfg"
	"unicode"
)

var _ = fmt.Print

type deadcodePass struct {
	ctxt *Link
	ldr  *loader.Loader
	wq   heap // 工作队列，使用最小堆获得更好的局部性

	ifaceMethod     map[methodsig]bool // 在到达的接口中声明的方法
	markableMethods []methodref        // 到达类型的方法
	reflectSeen     bool               // 我们是否看到了reflect方法调用
	dynlink         bool

	methodsigstmp []methodsig // 用于解码方法签名的暂存缓冲区
}

func (d *deadcodePass) init() {
	d.ldr.InitReachable()
	d.ifaceMethod = make(map[methodsig]bool)
	if buildcfg.Experiment.FieldTrack {
		d.ldr.Reachparent = make([]loader.Sym, d.ldr.NSym())
	}
	d.dynlink = d.ctxt.DynlinkingGo()

	if d.ctxt.BuildMode == BuildModeShared {
		// 在下列情况下，将此库中定义的所有符号标记为可访问
		// 建立一个共享的图书馆。
		n := d.ldr.NDef()
		for i := 1; i < n; i++ {
			s := loader.Sym(i)
			d.mark(s, 0)
		}
		return
	}

	var names []string

	// 在普通二进制文件中，从main.main和init开始
	// 函数并标记从那里可以访问的内容。
	if d.ctxt.linkShared && (d.ctxt.BuildMode == BuildModeExe || d.ctxt.BuildMode == BuildModePIE) {
		names = append(names, "main.main", "main..inittask")
	} else {
		// 外部链接器直接引用主符号。
		if d.ctxt.LinkMode == LinkExternal && (d.ctxt.BuildMode == BuildModeExe || d.ctxt.BuildMode == BuildModePIE) {
			if d.ctxt.HeadType == objabi.Hwindows && d.ctxt.Arch.Family == sys.I386 {
				*flagEntrySymbol = "_main"
			} else {
				*flagEntrySymbol = "main"
			}
		}
		names = append(names, *flagEntrySymbol)
	}
	// runtime.unreachableMethod是一个在调用时将抛出的函数。
	// 我们将无法访问的方法重定向到它。
	names = append(names, "runtime.unreachableMethod")
	if !d.ctxt.linkShared && d.ctxt.BuildMode != BuildModePlugin {
		// runtime.buildVersion和runtime.modinfo在.go.buildinfo部分中引用
		// （参见data.go中的函数buildinfo）。通常情况下，可以从
		// 运行时。以防万一，把它说清楚就行了。
		names = append(names, "runtime.buildVersion", "runtime.modinfo")
	}
	if d.ctxt.BuildMode == BuildModePlugin {
		names = append(names, objabi.PathToPrefix(*flagPluginPath)+"..inittask", objabi.PathToPrefix(*flagPluginPath)+".main", "go.plugin.tabs")

		// 我们不保留go.plugin.exports符号，
		// 但我们保留了它所指的符号。
		exportsIdx := d.ldr.Lookup("go.plugin.exports", 0)
		if exportsIdx != 0 {
			relocs := d.ldr.Relocs(exportsIdx)
			for i := 0; i < relocs.Count(); i++ {
				d.mark(relocs.At(i).Sym(), 0)
			}
		}
	}

	if d.ctxt.Debugvlog > 1 {
		d.ctxt.Logf("deadcode start names: %v\n", names)
	}

	for _, name := range names {
		// 将符号标记为数据/ABI0符号。
		d.mark(d.ldr.Lookup(name, 0), 0)
		// 同时标记任何Go功能（内部ABI）。
		d.mark(d.ldr.Lookup(name, sym.SymVerABIInternal), 0)
	}

	// 所有动态输出都是根。
	for _, s := range d.ctxt.dynexp {
		if d.ctxt.Debugvlog > 1 {
			d.ctxt.Logf("deadcode start dynexp: %s<%d>\n", d.ldr.SymName(s), d.ldr.SymVersion(s))
		}
		d.mark(s, 0)
	}
}

func (d *deadcodePass) flood() {
	var methods []methodref
	for !d.wq.empty() {
		symIdx := d.wq.pop()

		d.reflectSeen = d.reflectSeen || d.ldr.IsReflectMethod(symIdx)

		isgotype := d.ldr.IsGoType(symIdx)
		relocs := d.ldr.Relocs(symIdx)
		var usedInIface bool

		if isgotype {
			if d.dynlink {
				// 动态链接时，类型可以通过DSO传递
				// 边界并转换为另一侧的接口。
				d.ldr.SetAttrUsedInIface(symIdx, true)
			}
			usedInIface = d.ldr.AttrUsedInIface(symIdx)
		}

		methods = methods[:0]
		for i := 0; i < relocs.Count(); i++ {
			r := relocs.At(i)
			if r.Weak() {
				continue
			}
			t := r.Type()
			switch t {
			case objabi.R_METHODOFF:
				if i+2 >= relocs.Count() {
					panic("expect three consecutive R_METHODOFF relocs")
				}
				if usedInIface {
					methods = append(methods, methodref{src: symIdx, r: i})
					// 方法描述符本身就是一个类型描述符，并且
					// 它可用于达到其他类型，例如通过使用
					// reflect.Type.Method（i）.Type.In（j）。我们需要穿越
					// 它的子类型与UsedInFace集相同。（另见
					// 评论如下。）
					rs := r.Sym()
					if !d.ldr.AttrUsedInIface(rs) {
						d.ldr.SetAttrUsedInIface(rs, true)
						if d.ldr.AttrReachable(rs) {
							d.ldr.SetAttrReachable(rs, false)
							d.mark(rs, symIdx)
						}
					}
				}
				i += 2
				continue
			case objabi.R_USETYPE:
				// 用于矮人的类型符号。我们需要加载符号，但可能无法加载
				// 可以在程序中以其他方式访问。
				// 暂时不执行任何操作，因为我们仍然加载所有类型符号。
				continue
			case objabi.R_USEIFACE:
				// R_USEIFACE是一个标记重定位，告诉链接器类型为
				// 转换为一个接口，即应具有UsedInFace设置。见
				// 请在下面评论我们为什么需要取消可访问位的设置并重新标记它。
				rs := r.Sym()
				if !d.ldr.AttrUsedInIface(rs) {
					d.ldr.SetAttrUsedInIface(rs, true)
					if d.ldr.AttrReachable(rs) {
						d.ldr.SetAttrReachable(rs, false)
						d.mark(rs, symIdx)
					}
				}
				continue
			case objabi.R_USEIFACEMETHOD:
				// R_USEIFACEMETHOD是标记接口的标记重新定位
				// 使用的方法。
				rs := r.Sym()
				if d.ctxt.linkShared && (d.ldr.SymType(rs) == sym.SDYNIMPORT || d.ldr.SymType(rs) == sym.Sxxx) {
					// 不要解码共享库中的符号（我们将标记所有导出的方法）。
					// 我们同时检查SDYNIMPORT和Sxxx，因为名称损坏的符号尚未显示
					// 现在已经解决了。
					continue
				}
				m := d.decodeIfaceMethod(d.ldr, d.ctxt.Arch, rs, r.Add())
				if d.ctxt.Debugvlog > 1 {
					d.ctxt.Logf("reached iface method: %v\n", m)
				}
				d.ifaceMethod[m] = true
				continue
			}
			rs := r.Sym()
			if isgotype && usedInIface && d.ldr.IsGoType(rs) && !d.ldr.AttrUsedInIface(rs) {
				// 如果将类型转换为接口，则可以获取
				// 使用反射与“子”类型的it接口（例如获取
				// 来自[]的T的接口。我们需要遍历它的“子”类型
				// 设置了UsedInFace属性。
				// 当访问子类型（上面示例中的chant）时，它将
				// 如果您使用了iFace set，那么它将依次标记和（重新）访问其孩子
				// （如上面的T）。
				// 我们在这里取消可访问位的设置，因此如果已经访问了子类型，
				// 它将再次被参观。
				// 请注意，类型符号最多可以访问两次，一次不访问
				// 使用一次一次。因此，终止仍然是有保证的。
				d.ldr.SetAttrUsedInIface(rs, true)
				d.ldr.SetAttrReachable(rs, false)
			}
			d.mark(rs, symIdx)
		}
		naux := d.ldr.NAux(symIdx)
		for i := 0; i < naux; i++ {
			a := d.ldr.Aux(symIdx, i)
			if a.Type() == goobj.AuxGotype {
				// 一个可以到达的符号并不意味着我们需要它
				// 类型描述符。不要标记它。
				continue
			}
			d.mark(a.Sym(), symIdx)
		}
		// 某些主体对象符号具有外部对象，其作用类似于
		// “承运商”符号，或它包含某个特定项目的所有符号
		// 部分我们需要标记该承运人的所有“参考”符号，
		// 所以我们要确保我们把所有的外部符号和它们的子符号都拉进去
		// 符号。这并不理想，这些载体/区段符号可能
		// 被移除。
		if d.ldr.IsExternal(symIdx) {
			d.mark(d.ldr.OuterSym(symIdx), symIdx)
			d.mark(d.ldr.SubSym(symIdx), symIdx)
		}

		if len(methods) != 0 {
			if !isgotype {
				panic("method found on non-type symbol")
			}
			// 解码类型方法的运行时类型信息
			// 帮助确定可以调用哪些方法
			// 动态地通过接口。
			methodsigs := d.decodetypeMethods(d.ldr, d.ctxt.Arch, symIdx, &relocs)
			if len(methods) != len(methodsigs) {
				panic(fmt.Sprintf("%q has %d method relocations for %d methods", d.ldr.SymName(symIdx), len(methods), len(methodsigs)))
			}
			for i, m := range methodsigs {
				methods[i].m = m
				if d.ctxt.Debugvlog > 1 {
					d.ctxt.Logf("markable method: %v of sym %v %s\n", m, symIdx, d.ldr.SymName(symIdx))
				}
			}
			d.markableMethods = append(d.markableMethods, methods...)
		}
	}
}

func (d *deadcodePass) mark(symIdx, parent loader.Sym) {
	if symIdx != 0 && !d.ldr.AttrReachable(symIdx) {
		d.wq.push(symIdx)
		d.ldr.SetAttrReachable(symIdx, true)
		if buildcfg.Experiment.FieldTrack && d.ldr.Reachparent[symIdx] == 0 {
			d.ldr.Reachparent[symIdx] = parent
		}
		if *flagDumpDep {
			to := d.ldr.SymName(symIdx)
			if to != "" {
				if d.ldr.AttrUsedInIface(symIdx) {
					to += " <UsedInIface>"
				}
				from := "_"
				if parent != 0 {
					from = d.ldr.SymName(parent)
					if d.ldr.AttrUsedInIface(parent) {
						from += " <UsedInIface>"
					}
				}
				fmt.Printf("%s -> %s\n", from, to)
			}
		}
	}
}

func (d *deadcodePass) markMethod(m methodref) {
	relocs := d.ldr.Relocs(m.src)
	d.mark(relocs.At(m.r).Sym(), m.src)
	d.mark(relocs.At(m.r+1).Sym(), m.src)
	d.mark(relocs.At(m.r+2).Sym(), m.src)
}

// 死码标记所有可到达的符号。
// None
// 消除死亡代码的基础是大量的符号，
// 在他们重新安置之后，从*flagEntrySymbol开始。
// None
// 这种泛洪填充被包装在逻辑中，用于修剪未使用的方法。
// 所有方法都是通过在其接收器的*rtype上重新定位来提及的。
// 这些重新定位由编译器专门定义为R_METHODOFF
// 所以我们可以在这里检测和操纵它们。
// None
// 可访问类型的方法有三种调用方式：
// None
// 1.直拨电话
// 2.通过可访问的接口类型
// 3.reflect.Value.Method（或MethodByName）或reflect.Type.Method
// （或MethodByName）
// None
// 第一种情况由直接调用的方法flood fill处理
// 标记为可访问。
// None
// 第二种情况是通过分解所有可到达的接口来处理
// 输入到方法签名中。比较遇到的每种方法
// 对于接口方法签名，如果匹配，则标记它
// 如可及。这是非常保守的，但简单而正确。
// None
// 第三种情况是通过查看以下任何情况来处理：
// -reflect.Value.Method或MethodByName是可访问的
// -调用reflect.Type.Method或MethodByName（通过
// 由编译器标记的REFLECTMETHOD属性）。
// 如果发生上述任何一种情况，则所有下注都将被取消，并且所有导出的方法都将被取消
// 可到达类型的个数被标记为可到达。
// None
// 将从ctxt.Textp中删除所有未读取的文本符号。
func deadcode(ctxt *Link) {
	ldr := ctxt.loader
	d := deadcodePass{ctxt: ctxt, ldr: ldr}
	d.init()
	d.flood()

	methSym := ldr.Lookup("reflect.Value.Method", sym.SymVerABIInternal)
	methByNameSym := ldr.Lookup("reflect.Value.MethodByName", sym.SymVerABIInternal)

	if ctxt.DynlinkingGo() {
		// 导出的方法可能满足我们不知道的接口
		// 动态链接时，大约还没有。
		d.reflectSeen = true
	}

	for {
		// 方法可以通过反射调用。放弃
		// 静态分析，标记所有导出的方法
		// 所有可到达的类型都是可到达的。
		d.reflectSeen = d.reflectSeen || (methSym != 0 && ldr.AttrReachable(methSym)) || (methByNameSym != 0 && ldr.AttrReachable(methByNameSym))

		// 标记所有可以满足已发现问题的方法
		// 接口是可访问的。我们重新检查旧的标记接口
		// 因为可能已经发现了新类型（使用新方法）
		// 在最后关口。
		rem := d.markableMethods[:0]
		for _, m := range d.markableMethods {
			if (d.reflectSeen && m.isExported()) || d.ifaceMethod[m.m] {
				d.markMethod(m)
			} else {
				rem = append(rem, m)
			}
		}
		d.markableMethods = rem

		if d.wq.empty() {
			// 没有发现新的工作。完成。
			break
		}
		d.flood()
	}
}

// methodsig是一个类型化方法签名（名称+类型）。
type methodsig struct {
	name string
	typ  loader.Sym // 函数的类型描述符符号
}

// methodref保存从接收器类型符号到其
// 方法有三个重新定位，每个字段一个
// reflect.method结构：mtyp、ifn和tfn。
type methodref struct {
	m   methodsig
	src loader.Sym // 接收器类型符号
	r   int        // R_METHODOFF重新定位的索引
}

func (m methodref) isExported() bool {
	for _, r := range m.m.name {
		return unicode.IsUpper(r)
	}
	panic("methodref has no signature")
}

// decodeMethodSig对方法签名信息数组进行解码。
// 数组的每个元素的大小为个字节。前4个字节是一个
// nameOff表示方法名，接下来的4个字节是
// 函数类型。
// None
// 这是runtime.method和runtime.imethod的布局。
func (d *deadcodePass) decodeMethodSig(ldr *loader.Loader, arch *sys.Arch, symIdx loader.Sym, relocs *loader.Relocs, off, size, count int) []methodsig {
	if cap(d.methodsigstmp) < count {
		d.methodsigstmp = append(d.methodsigstmp[:0], make([]methodsig, count)...)
	}
	var methods = d.methodsigstmp[:count]
	for i := 0; i < count; i++ {
		methods[i].name = decodetypeName(ldr, symIdx, relocs, off)
		methods[i].typ = decodeRelocSym(ldr, symIdx, relocs, int32(off+4))
		off += size
	}
	return methods
}

// 在offset off处解码接口类型符号symIdx的方法。
func (d *deadcodePass) decodeIfaceMethod(ldr *loader.Loader, arch *sys.Arch, symIdx loader.Sym, off int64) methodsig {
	p := ldr.Data(symIdx)
	if decodetypeKind(arch, p)&kindMask != kindInterface {
		panic(fmt.Sprintf("symbol %q is not an interface", ldr.SymName(symIdx)))
	}
	relocs := ldr.Relocs(symIdx)
	var m methodsig
	m.name = decodetypeName(ldr, symIdx, &relocs, int(off))
	m.typ = decodeRelocSym(ldr, symIdx, &relocs, int32(off+4))
	return m
}

func (d *deadcodePass) decodetypeMethods(ldr *loader.Loader, arch *sys.Arch, symIdx loader.Sym, relocs *loader.Relocs) []methodsig {
	p := ldr.Data(symIdx)
	if !decodetypeHasUncommon(arch, p) {
		panic(fmt.Sprintf("no methods on %q", ldr.SymName(symIdx)))
	}
	off := commonsize(arch) // reflect.rtype
	switch decodetypeKind(arch, p) & kindMask {
	case kindStruct: // reflect.structType
		off += 4 * arch.PtrSize
	case kindPtr: // reflect.ptrType
		off += arch.PtrSize
	case kindFunc: // reflect.funcType
		off += arch.PtrSize // 4字节，指针对齐
	case kindSlice: // 反射.切片类型
		off += arch.PtrSize
	case kindArray: // reflect.arrayType
		off += 3 * arch.PtrSize
	case kindChan: // 1.chanType
		off += 2 * arch.PtrSize
	case kindMap: // 映射类型
		off += 4*arch.PtrSize + 8
	case kindInterface: // reflect.interfaceType
		off += 3 * arch.PtrSize
	default:
		// just Sizeof（rtype）
	}

	mcount := int(decodeInuxi(arch, p[off+4:], 2))
	moff := int(decodeInuxi(arch, p[off+4+2+2:], 4))
	off += moff                // 到reflect.method值数组的偏移量
	const sizeofMethod = 4 * 4 // 程序中reflect.method的大小
	return d.decodeMethodSig(ldr, arch, symIdx, relocs, off, sizeofMethod, mcount)
}
